Lender Price API Web Service
Lender Price API Web Service / ClosingCost Json Schema
In This Topic
    ClosingCost Json Schema
    In This Topic
    Description

    The ClosingCost model contains the fields used for regulating adjustments, including the closingCostGroup object array holding information on each closing cost group.

    There are three scenarios that determine whether or not a client should utilize ClosingCost.

    Use ClosingCost for:

    1. clients who do not utilize Lender Price's "Closing Cost" Setup in the application and want to pass fees manually. ClosingCost is where clients add an array list of fees. The fees list can be either flat or multi-level.

    ClosingCost is not necessary for:

    1. clients that complete pre-setup fees and tables with associated data in the Lender Price application UI and assign them to user groups or API users. Upon receiving the request, Lender Price will automatically populate this object using the User ID present in the API request.
    2. clients who utilize Ernst Integration or have their own fee integration that Lender Price can connect to.

    Ignoring ClosingCost will automatically calculate a closing cost for the search.

     

    Overview
    ClosingCost

    The ClosingCost model contains the fields used for regulating adjustments, including the closingCostGroup object array holding information on each closing cost group.

    There are three scenarios that determine whether or not a client should utilize ClosingCost.

    Use ClosingCost for:

    1. clients who do not utilize Lender Price's "Closing Cost" Setup in the application and want to pass fees manually. ClosingCost is where clients add an array list of fees. The fees list can be either flat or multi-level.

    ClosingCost is not necessary for:

    1. clients that complete pre-setup fees and tables with associated data in the Lender Price application UI and assign them to user groups or API users. Upon receiving the request, Lender Price will automatically populate this object using the User ID present in the API request.
    2. clients who utilize Ernst Integration or have their own fee integration that Lender Price can connect to.

    Ignoring ClosingCost will automatically calculate a closing cost for the search.

     

    allowErnstQuote : boolean
    Appears in line result. This value is set to True if Ernst quote is allowed.
    closingCostGroup : Array[ClosingCostGroup]
    Contains an array of ClosingCostGroup objects with data for closing cost groups associated with the loan.
    aprRelated : boolean

    True if the closing cost is APR related.

     

    closingCostItems : Array[ClosingCostItems]
    An array of ClosingCostItems objects containing closing cost item data.
    amount : number
    amountScript : string
    aprRelated : boolean
    automaticallyCalculated : boolean
    callForQuote : boolean
    convertedFromPercenetage : boolean
    ernstType : string
    escrowWaiver : boolean
    evalType : string
    counter : integer
    internal only
    date : string

    The current date.

    internal only

    machineIdentifier : integer
    internal only
    processIdentifier : integer
    internal only
    time : integer
    internal only
    timeSecond : integer
    internal only
    timestamp : integer
    internal only
    includeInQmCriteria : boolean
    itemType : string
    items : Array[ClosingCostItem]
    amount : number
    amountScript : string
    aprRelated : boolean
    automaticallyCalculated : boolean
    callForQuote : boolean
    convertedFromPercenetage : boolean
    ernstType : string
    escrowWaiver : boolean
    evalType : string
    includeInQmCriteria : boolean
    itemType : string
    label : string
    name : string
    notes : Array[string]
    numberOfDaysForPrepaidInterest : integer
    numberOfPayments : integer
    percentPaidByBorrower : number
    percentageOfLoanAmount : number
    thirdPartyVendor : boolean
    totalBorrower : number
    totalBorrowerAprRelated : number
    totalBroker : number
    vendorName : string
    label : string
    name : string
    notes : Array[string]
    numberOfDaysForPrepaidInterest : integer
    numberOfPayments : integer
    percentPaidByBorrower : number
    percentageOfLoanAmount : number
    thirdPartyVendor : boolean
    totalBorrower : number
    totalBorrowerAprRelated : number
    totalBroker : number
    vendorName : string
    customFeeGroup : Array[string]
    A string array of custom fee groups.
    customTables : Array[ClosingCostCustomTable]
    An array of ClosingCostCustomTable objects storing custom closing cost tables.
    ausTypes : Array[string]
    columnItems : Array[ColumnCostItem]
    applyTax : boolean
    aprRelated : boolean
    asPercentage : boolean
    description : string
    idx : integer
    includeInQmCriteria : boolean
    label : string
    enable : boolean
    includeInSearch : boolean
    label : string
    loanAmountRange : Array[DoubleRangeLeGt]
    from : number
    null : boolean
    to : number
    loanPurposes : Array[string]
    loanTypes : Array[string]
    loanYears : Array[integer]
    mortgageTypes : Array[string]
    name : string
    propertyTypes : Array[string]
    propertyUses : Array[string]
    rawData : Array[HashMap]
    states : Array[string]
    tax : number
    termsInMonths : boolean
    values : Array[array]
    variableLoanTypes : Array[string]
    display : boolean
    Set
    fromErnstCost : boolean
    True if the closing cost group is from Ernst cost.
    groupType : string

    Specifies the group type of the closing cost group.

     

    id : ObjectId
    The closing cost group ID, stored in the ObjectId object along with internal metadata.
    name : string

    The name of the closing cost group.

     

     

    required : boolean
    True if this closing cost group is required in the closing cost calculation.
    total : number
    Total value of the closing cost group.
    directCustomFee : boolean
    settlementCost : SettlementCost
    Contains an array of SettlementCost objects with data on settlement costs associated with the loan.
    closingCostGroup : Array[ClosingCostGroup]
    closingCostGroup contains an array of ClosingCostGroup objects, each storing data on a closing cost group.
    origination : Origination
    Data on settlement cost origination, stored in the Origination object.
    administration : number
    administrationLabel : string
    lenderCredit : number
    lenderCreditLabel : string
    others : number
    othersLabel : string
    total : number
    underwriting : number
    underwritingLabel : string
    thirdPartyServices : ThirdPartyServices
    Data on third party services, stored in the ThirdPartyServices object.
    appraisal : number
    appraisalLabel : string
    creditReport : number
    creditReportLabel : string
    floodCertification : number
    floodCertificationLabel : string
    overnight : number
    overnightLabel : string
    recording : number
    recordingLabel : string
    taxService : number
    taxServiceLabel : string
    total : number
    titleService : TitleService
    Information on the title service of the settlement cost, stored in the TitleService object.
    total : number
    The settlement cost total amount.
    total : number

    Total closing cost value.

    Example:

    "total": 758
    useClosingCost : boolean
    True if calculated closing cost will be used.
    useCompanyDefaultClosingCost : boolean
    True if company default closing cost will be used.
    useErnstCost : boolean
    True if Ernst cost will be used.
    Properties
    NameDescriptionData Type
    Appears in line result. This value is set to True if Ernst quote is allowed.boolean
    Contains an array of ClosingCostGroup objects with data for closing cost groups associated with the loan.Array[ClosingCostGroup]
     boolean
    Contains an array of SettlementCost objects with data on settlement costs associated with the loan.SettlementCost

    Total closing cost value.

    Example:

    "total": 758
    number
    True if calculated closing cost will be used.boolean
    True if company default closing cost will be used.boolean
    True if Ernst cost will be used.boolean
    See Also